home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Night Owl 6
/
Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso
/
033a
/
vfam114.zip
/
VFAM.DOC
< prev
next >
Wrap
Text File
|
1991-05-10
|
52KB
|
1,176 lines
▄ ▄▄ ▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
█ ██ ██ █
█ ██ ██ ▄▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄ █ VersaFAM File Area Manager
█ ██ ██ █▀▀▀▀ █▀▀██ █▀▀▀▀ █▀▀██ █ for Opus, Maximus and other
█ ██▄ ▄██ █▄▄ █ ██ █▄▄▄ █▄▄██ █ Bulletin Board systems
█ ██ ██ █▀▀ █▀██▀ ▀███ █▀▀██ █
█ ████ █▄▄▄▄ █ █▄ ▄▄███ █ ██ █ Written by: Bill Auclair
█ ▀▀ ▀▀▀▀▀ ▀ ▀▀ ▀▀▀▀ ▀ ▀▀ █ FidoNet node # 1:141/545
█ ▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄ ▄▄▄ █ Copyright 1991 by XanSoft
█ ███▀▀▀▀▀▀ ███▀▀▀███ ████▄ ▄████ █ ALL RIGHTS RESERVED
█ ███ ███ ███ ███▀█▄▄█▀███ █
█ ███▄▄▄ ███▄▄▄███ ███ ██ ███ █ Disk/EMS swapping routines
█ ███▀▀▀ ███▀▀▀███ ███ ▀▀ ███ █ (C) 1988 TurboPower Software
█ ███ ███ ███ ███ ███ █
█ ███ ███ ███ ███ ███ █ ****************************
█ ███ ███ ███ ███ ███ █ V e r s i o n 1 . 1 4
█ █ ****************************
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
-------------------------------------------------------------------
DOCUMENT OUTLINE AND TABLE OF CONTENTS
-------------------------------------------------------------------
I. General Description ................................... 3
a. What is VersaFAM? ................................. 3
II. Installing and Configuring VersaFAM ................... 4
a. The VFAM environmental variable ................... 5
b. The VFAM.DAT configuration file ................... 5
i. configuration file verb definitions ........... 5
III. Using VersaFAM ........................................ 9
a. HELP screens ...................................... 9
b. 1st-level menu commands ........................... 9
c. 2nd-level menu commands ........................... 11
d. 3rd-level menu commands ........................... 15
e. The OEC text editor ............................... 16
f. Using text templates .............................. 20
g. Running VersaFAM remotely ......................... 21
IV. VersaFAM Utilities .................................... 22
a. FILEX file update utility ......................... 22
b. CBFSORT list file sort utility .................... 22
c. OEC2VFAM list file conversion utility ............. 22
d. VFADD path import utility ......................... 22
VersaFAM v1.14 - 2 -
-------------------------------------------------------------------
DISCLAIMER
-------------------------------------------------------------------
This software is provided "as is", without warranty of any kind,
either expressed or implied, including but not limited to implied
warranties of merchantability and fitness for a particular purpose.
You are advised to use this program at your own risk. XanSoft
Development, Inc. and/or Bill Auclair shall not be held liable for
any damages, including lost data, lost profits, lost monies or
other special, incidental or consequential damages arising from
the use or inability to use VersaFAM. The VersaFAM program package
may be freely distributed, providing the contents of the archive
are kept intact, and the executable files are not modified in
any way.
FILES INCLUDED IN THE VERSAFAM PACKAGE:
VFAM.DOC The documentation you're reading
FILEX.DOC FILEX program documentation
REGISTER.DOC VFAM registration information
VFAM.EXE The VersaFAM executable file
VFAM.OVR Overlay file for VFAM.EXE
FILEX.EXE The FILEX file update utility
CBFSORT.EXE The CBFSORT listfile sort utility
OEC2VFAM.EXE Converts OEC files to VersaFAM format
VFADD.EXE The VFADD path import utility
VFAM.DAT Sample VersaFAM configuration file
FILEX.DAT Sample FILEX configuration file
*.HDR Sample header files
*.TPL Sample text template files
GETVFAM.BAT A sample DOORWAY<tm> batch file
GETVFAM.MNU A sample DOORWAY<tm> password file
NOTE: Beginning with version 1.14, all executable files within the
VersaFAM archive have been compacted with the LZEXE compression
utility. This results in as much as 60% reduction in file sizes,
without any measurable degradation in performance.
VersaFAM v1.14 - 3 -
-------------------------------------------------------------------
GENERAL DESCRIPTION: What Is VersaFAM?
-------------------------------------------------------------------
VersaFAM is a file area manager for Opus 1.03x, 1.10x and other
compatible bulletin board systems using the same list file format.
VersaFAM was designed to optimize the efficiency of file management
through the use of scrolling windows, intuitive menus and virtual
screen data input, allowing sysops to manage file areas through the
use of *one* program, rather than several. VersaFAM will support
up to 256 file areas, with a maximum of 1024 files in each area,
for a total of 262,144 possible files. Built-in help screens
listing available keystroke commands and other useful information
are available by pressing the function keys from any part of
VersaFAM *except* the text editor. VersaFAM supports list files of up
to 1024 lines. Each line can contain up to 127 characters, including
OEC control codes.
OVERLAYS AND MEMORY-SWAPPING
----------------------------
VersaFAM makes use of special memory-swapping routines developed by
Kim Kokkonen of TurboPower Software. When invoking the VersaFAM
DOS shell or any of the external program "hooks", most of the
VersaFAM program is intelligently swapped out to expanded memory or
hard disk, leaving more memory to use while within the shell or program.
VersaFAM versions 1.14 and up are now overlaid in combination with "smart"
dynamic memory allocation, reducing RAM overhead needed to a minimum of
approximately 165K. If EMS memory is available, the overlay manager uses
it instead of swapping overlays from disk.
EMS MEMORY AVAILABILITY
-----------------------
While VersaFAM will work perfectly well without expanded memory, it
is highly recommended that approximately 130-150K of EMS memory be
free for use by the program. VersaFAM will operate much faster if
it is able to swap to EMS, rather than to a slower hard disk drive.
A compromise might be to specify a RAM disk as the swap directory.
BASIC FUNCTIONS
---------------
Used as a basic file area manager, VersaFAM can be used to HURL, DUPE,
MOVE, ERASE or otherwise manipulate files and file descriptions from one
subdirectory to another, automatically updating list files for the
subdirectories involved. An integrated LOCATE function makes searching for
specific files and/or file descriptions quick and easy. An integrated
MARK/UNMARK function can be used in conjunction with HURL, DUPE and ERASE
to facilitate mass processing of files.
ARCHIVE UTILITY SUPPORT
-----------------------
Full archive utility support is now "hard-coded" into VersaFAM. Files
archived in LZH (both old and new), ZIP, ARC, ARJ and PAK formats can be
listed, extracted, edited and even updated with a few keystrokes.
Regular files can be archived just as easily. Text files, archived or
unarchived, can be viewed with a keystroke, using your favorite editor.
VersaFAM v1.14 - 4 -
OEC TEXT EDITOR
---------------
VersaFAM supports a subset of the Opus Embedded Codes (used to
change text and background colors) in its text editor.
With virtual screen input, users can add, change or delete file names,
file descriptions or descriptive text lines as desired. Entire
lines can be inserted, moved, copied or deleted as needed. Ten special
graphics character sets can be accessed through function keys. OEC text
encode/decode can be turned off by using the NoOEC configuration file
verb, or by pressing CTRL/O at the 2nd-level menu. A bi-level text
search capability is also fully implemented.
EXTERNAL FUNCTIONS
------------------
External programs may be invoked within VersaFAM, which will swap itself
to EMS or hard disk and pass control to the called program. When the
external program finishes its work, it will terminate and pass control
back to VersaFAM. Some external routines have been "hard-coded"
into VersaFAM-- the INDEX, PROBE, PACK, UNPACK and TEXT commands are
examples of this. Up to ten additional external program calls may be
user-specified in conjunction with the EXTFUNCxx verbs in the VFAM.DAT
configuration file.
TEXT TEMPLATES
--------------
Up to 10 text "template" files may be specified for easy insertion
anywhere within the body of a list file, saving users the effort of
having to create often-used text and graphics from scratch.
REMOTE OPERATION
----------------
VersaFAM can be run remotely, in conjunction with Marshall Dudley's
DOORWAY<tm> or similar I/O redirection utilities. All local keyboard
operations, including extended keycode ALT, CTRL, SHIFT and function key
combinations are fully supported in remote mode.
INFORMATION FILE
----------------
The automatic addition of a user-specified "information file" to
archive libraries has been implemented in VersaFAM v1.08 and later.
-------------------------------------------------------------------
INSTALLING AND CONFIGURING VERSAFAM
-------------------------------------------------------------------
To use VersaFAM, first copy the VFAM.EXE executable file, the VFAM.OVR
overlay file and the VFAM.DAT configuration file to a suitable
subdirectory. All three files should be in the same subdirectory,
preferably one defined in the DOS path statement.
VersaFAM v1.14 - 5 -
-------------------------------------------------------------------
THE VFAM ENVIRONMENTAL VARIABLE
-------------------------------------------------------------------
VersaFAM depends upon the use of a DOS environmental variable to
maximize the ease of navigation through different drives and
directories on your system. Add the following line to your
AUTOEXEC.BAT file, then reboot your system:
set VFAM=d:\path
where d:\path is the drive and subdirectory in which the VersaFAM
configuration file VFAM.DAT is located. The VersaFAM executable
file VFAM.EXE may be placed in a subdirectory within your DOS
path, so that it is available from any subdirectory.
-------------------------------------------------------------------
THE VFAM.DAT CONFIGURATION FILE
-------------------------------------------------------------------
VFAM.DAT is the name of the ASCII text file that tells VersaFAM where
the list file subdirectories are located, and also which program
options have been chosen. VersaFAM cannot run without VFAM.DAT.
VFAM.DAT should be edited to reflect your system's parameters.
A simple text editor can be used for this purpose. Do not use fancy
word processing programs to edit VFAM.DAT, as the extra codes they
add may confuse VersaFAM.
If you run an Opus<tm> system, the VFADD path import utility may be
used to quickly append path information from Opus SYSTEM??.BBS or
SYSTEM??.DAT files to VFAM.DAT. Invoke VFADD from DOS with no
command-line parameters for further information.
Configuration file verbs, listed in alphabetical order:
BACKUP- The name of the file to copy list file contents to when
using the BACKUP command in the 1st-level menu. No drive/
path information is required.
BIOS- If uncommented (no semicolon before it), specifies use of
slower BIOS screen writes, rather than the default direct
writes. You may need to use this option if you're having
trouble with screens "bleeding" from one partition to
another in a multitasking setup, or if you wish to run
VersaFAM as a remotely-controlled "door".
DOS
PASSWORD- The password authorizing remote access to DOS using the OS
function in 1st, 2nd or 3rd-level menus.
VersaFAM v1.14 - 6 -
EDITOR- Specifies the utility to be used to display or edit files.
The utility must be one in which the name of the target
file can be specified on the command line, as in the
example LIST <filename.ext>. If an editor is not
specified, LIST is used by default.
EXTFUNCx- Full drive, path and filename information for external programs
to be invoked from within VersaFAM by pressing ALT-F1 through
ALT-F10 (depending upon which program is desired) at the 2nd-
level menu. A maximum of ten external programs may be specified.
INFOFILE- The full drive and path information for the file to be
optionally added as an "information file" to archives.
LISTFILE- The name of the file containing file description info,
usually FILES.BBS for Opus systems. No drive/path
information is required.
LISTHDR- The full drive, path and filename information describing
the file you wish to use as a "header" file for each file
area. When creating a new file area from scratch, or if
the list file for an area is not found, this file will
automatically be appended to the beginning of the list
file, if specified. The list file header can optionally be
inserted anywhere within the list file by positioning the
cursor to the desired location and pressing ALT-H at the
2nd-level menu.
MONITOR
DRIVE- The drive whose free space is to be monitored on the 1st-level
menu. A trailing backslash ("\") is not required.
NOEMS- Tells VFAM not to use expanded memory, even if it is available.
NOOEC- Tells VFAM to "turn off" encode/decode of OEC codes.
NOLOGO- Disables the VFAM logo at the 1st menu level.
ORPHAN
DESC- Specifies the descriptive string to be appended to all
PROBEd files in the list file, using the externally-called
FILEX file update utility.
NOTE: FILEX OEC color codes can be used in conjunction
with this feature to give adopted file descriptions a
distinctive color, blink, etc. See the FILEX
documentation for more details.
VersaFAM v1.14 - 7 -
PACKER- Specifies the utility to be used to archive files. The
descriptors below are valid:
ARCA
ARJ
PAK
PKZIP
LHARC
LHA
If PACKER is not specified, "ARCA" is used by default. The
specified PACKER must be available on your DOS path.
REPACK
EDITFILE- Enables updating of archive files with "new" version after an
editing operation has been performed using the VIEW and TEXT
commands (This assumes a text editor has been associated with
the EDITOR configuration file verb). NOTE: This option adds
considerable time to the editing process, and should only be
used when absolutely necessary. Due to limitations of the ARCA
program, updating of ARCed files is not supported.
SOUND- Leave this line commented if you don't want VersaFAM to
"beep" when entering text edit mode, when missing
files are encountered, or when long file lines are found.
STATUS
LOG- Full path and filename of the file to be used to log VersaFAM
operations. If the file does not exist, it will be created; if
it already exists, it will be appended.
SWAPDIR- The full drive and path information used for storage of the
hidden swap file (VFAM.$$$) generated whenever VersaFAM is
swapped to hard disk. If not specified, defaults to the
string specified in the VFAM environmental variable. Not
used if sufficient EMS memory is available.
SYSDIR- The full drive and path information for each of the file
areas you wish to use with VersaFAM. A trailing backslash
("\") is not required.
TEMPLATEx- The full drive, path and filename information for files
to be used as text templates. Templates can be inserted
anywhere within a list file by pressing CTRL-F1 through
CTRL-F10 (depending upon the template to be used) at the
2nd-level menu. A maximum of ten template files may be
specified.
VersaFAM v1.14 - 8 -
TEXTFLAG- The identity of the character to use when "padding"
the first column of a non-file text line in text
edit mode. This padding has to be done so Opus (and
other BBS software) won't try to interpret the text
as a filename. The default is SPACE (' ').
UNARCDIR- The full drive and path information for the directory you
wish files to be UNPACKed to. This subdirectory is also used
by VersaFAM as a temporary storage area for VIEWed files.
A trailing backslash ("\") is not required.
ZAPDIR- The full drive and path information for the directory you
wish to use as a ZAP directory (a directory where old/obsolete
files are stored prior to archiving/deleting). The ZAP
directory is automatically appended as the last entry in the
list of ACTIVE subdirectories, facilitating single-keystroke
access through use of the END key. A trailing backslash ("\")
is not required.
NOTE: This was formerly the SALEDIR verb in older VFAM
versions. If using an older config file, you will have to
change "SALEDIR" to "ZAPDIR" for this to work.
VersaFAM v1.14 - 9 -
-------------------------------------------------------------------
USING VERSAFAM
-------------------------------------------------------------------
VersaFAM is invoked from the DOS command line by typing VFAM and
pressing the <ENTER> key. This will bring up the 1st-level menu.
If the VFAM.DAT file has been configured correctly, you should see
a listing of ACTIVE directories, a ZAP directory, and a list
file name. Use the cursor arrow keys, the Pg keys, the Home or End
keys to change the location of the highlight bar. The position of
the highlight bar determines which file area is to be displayed in
the 2nd level menu.
-------------------------------------------------------------------
THE HELP SCREENS
-------------------------------------------------------------------
Detailed help screens are available to the novice VersaFAM user by
pressing F1, F2 or F3 anywhere within the program *except* the text
editor.
The F1 help screen lists undocumented keystroke commands not displayed
on menu screens.
The F2 help screen lists current external program assignments (if any),
as determined by the EXTFUNCx verbs in VFAM.DAT.
The F3 help screen lists current text template file assignments (if any),
as determined by the TEMPLATEx verbs in VFAM.DAT.
-------------------------------------------------------------------
1ST-LEVEL MENU COMMANDS
-------------------------------------------------------------------
Available 1st-level menu commands are:
ZAP- Automatically erases all files referenced in the list file
for the ZAP directory. A quick, easy way to clean out
obsolete files. The ZAP directory list file is updated.
LOCATE- Allows searching/matching of file names and descriptions
to a user-specified search string. If invoked at the 1st
menu level, LOCATE will automatically search the list file
for each file area, *starting* from the current cursor
location. If a match is found, the 2nd menu level is
invoked for the specified subdirectory, and the cursor is
moved to the file line containing the matching string.
If a match is not found, a "no match found!" message is
displayed on the 1st level menu screen.
VersaFAM v1.14 - 10 -
INDEX- Swaps VersaFAM out of memory and activates the external
CBFSORT list file sorting program. All groupings and
subgroupings of files within the list file at the cursor
position are alphanumerically sorted. The position of
text and descriptive lines is not changed.
PROBE- Swaps VersaFAM out of memory and activates the external
FILEX list file update program. FILEX is passed a
command line by VersaFAM that instructs it to probe the
currently active directory, looking for any files not
displayed in the list file. If such files are found,
their names are automatically appended to the list file,
along with a user-specified description determined by
the OrphanDesc verb in the VFAM.DAT configuration file.
NOTE: Newer versions of VersaFAM are incompatible with FILEX
versions older than 1.07a-- if you are using FILEX 1.06 or
older, please upgrade to the newer version included in this
archive.
OS- Shells to DOS. If operating remotely, users will first be
prompted for a password. Incorrect passwords will force a
return to whatever menu level OS was invoked from. Type 'EXIT'
and then press <ENTER> to return to VersaFAM. VersaFAM uses
memory-swapping routines written by Kim Kokkonen of TurboPower
Software. These routines maximize the amount of usable RAM in
the shell by swapping most of the parent program to disk or to
EMS memory.
BACKUP- Backs up the list file in the currently ACTIVE directory by
copying it to a specified filename in the same directory.
QUIT- Terminates the VersaFAM program. The ESC key can no longer
be used for this purpose at the 1st menu level.
Cursor
keys- Use the cursor arrow keys to move through the listed
subdirectories one at a time. Use the PgUp/PgDn keys
to move through the listed subdirectories one screenful
at a time. Use the HOME and END keys to move to the top
and bottom of the subdirectory list, respectively.
ESC key- Press <ESC> to back up to a previous menu level, or quit
the VersaFAM program.
VersaFAM v1.14 - 11 -
-------------------------------------------------------------------
2ND-LEVEL MENU COMMANDS
-------------------------------------------------------------------
After a file area has been selected in the 1st-level menu, the
2nd-level menu is brought up. The list file name, ZAP
directory, currently ACTIVE directory and UNARC directory
are displayed. If the cursor is moved to a valid file description
line using cursor keys, the FILE DATE, FILE SIZE and FILE NAME
windows will list information for the file at the cursor location.
If the file line does not contain a valid file description (e.g.,
a descriptive text line), the phrase 'NON-FILE' will appear in the
FILE SIZE window; the FILE DATE and FILE NAME windows will blank.
If a valid file at the cursor location cannot be found in DOS, the
word 'MISSING' will appear in the FILE SIZE window; the FILE DATE
and FILE NAME windows will blank; the file description will be
appended with OEC codes, causing it to blink off and on. The only
2nd-level command valid for MISSING files is DELete.
If a file line is of a length that would cause it to "wrap" to the next
line when displayed in Opus and other compatible BBS programs, VFAM will
flag this condition by highlighting the line when the cursor is moved
over it. Long lines will be displayed in light blue on a gray background,
rather than the standard black on gray background. If the SOUND verb
is active in VFAM.DAT, an audible tone will sound when the cursor is
moved over long lines.
Available 2nd-level menu commands are:
ERASE- Deletes the file at the current cursor position in the current
ACTIVE directory. List file is updated.
INDEX- Swaps VersaFAM out of memory and activates the external
CBFSORT list file sorting program. All groupings and
subgroupings of files within the currently active
list file are alphanumerically sorted. The position of
text and descriptive lines is not changed.
HURL- Transfers a file from the current ACTIVE directory to
any other valid directory specified in the VFAM.DAT
configuration file. List files in both directories are
updated. Hurling across drives is supported. When the
split-screen HURL display appears, use the cursor arrow keys,
HOME key or END key to automatically scroll through a
list of input selections determined by the SYSDIR verbs in
VFAM.DAT. When the desired directory name is highlighted, press
the <ENTER> key.
WRITE- Enables the VersaFAM OEC text editor. See the section titled
"THE OEC TEXT EDITOR" for more information.
VersaFAM v1.14 - 12 -
MOVE- Allows physical relocation of filenames and descriptions
within a list file. When the letter "M" is pressed, the
entry under the current cursor location is "picked up",
highlighted in blinking reverse video. The cursor arrow
keys, Pg keys or Home/End keys can then be used to
transport the highlighted file line to another location
within the same list file. Pressing ENTER "puts down" the
file line once a suitable location is found.
LOCATE- Allows searching searching/matching of filenames and
descriptions to a user-specified search string. If
invoked from the 2nd menu level, LOCATE will automatically
search the current list file for a string to match the
specified search string, *starting* at the current cursor
location. If a 1st-level LOCATE has previously been done,
the search string for that operation is retained for
default use, or can be changed as required. If a matching
string is not found, a "no match found!" message is
displayed on the 2nd-level menu screen.
RENAME- Allows renaming of a file or file extension at the DOS
level. The list file is also updated. Only the
overstrike cursor can be used in this mode.
DUPE- Copies the selected file to any valid subdirectory. The
list file is not updated.
VIEW- Allows the contents of ARCed, PAKed, ARJed, ZIPed or LHARCed
archive files to be viewed in a row-and-column format
similar to that provided by the utilities themselves.
Archive identification is automatic, regardless of the
file extensions used. VIEW will not work on non-archived
files, or files using a compression format different from
those described above.
TEXT- Allows the contents of a listed text file to be displayed
in the user's favorite editor or file list utility,
dependent upon the information supplied after the 'Editor'
verb in the VFAM.DAT configuration file.
OS- Shells to DOS. If operating remotely, users will first be
prompted for a password. Incorrect passwords will force a
return to whatever menu level OS was invoked from. Type 'EXIT'
and then press <ENTER> to return to VersaFAM. VersaFAM uses
memory-swapping routines written by Kim Kokkonen of TurboPower
Software. These routines maximize the amount of usable RAM in
the shell by swapping most of the parent program to disk or to
EMS memory.
VersaFAM v1.14 - 13 -
PACK- Swaps VersaFAM out of memory, and activates an external
compression utility specified by the 'Packer' verb in the
VFAM.DAT configuration file. The file at the current
cursor position is archived, and given a file extension
reflecting the utility used.
UNPACK- Swaps VersaFAM out of memory, and activates an external
decompression utility, the identity of which is determined
by the archive type at the current cursor position. The
archive file at the cursor position is de-archived to the
directory specified after the 'UnarcDir' verb in the
VFAM.DAT configuration file.
QUIT- Quits the VersaFAM program.
ESC key- Press this key to back up a menu level.
INS key- Press this key to insert a blank line into a list file.
DEL key- Press this key to delete the list file line at the
current cursor location, whether it contains a valid
filename or not. Does not erase files.
ALT/A- Used to automatically add a user-specified "information
file" to the archive at the current cursor position.
The identity of the info file is determined by the
'InfoFile' verb in the VFAM.DAT configuration file.
ALT/C- Copies a text line at the cursor position, displaying it
immediately above the original text line.
ALT/H- Adds a header file (specified by the ListHdr verb in VFAM.DAT)
at the current cursor location.
ALT/L- Loads an alternate list file for viewing/editing.
ALT/M- MARKS all files in the file list for processing.
ALT/U- un-MARKS all files in the file list.
F9- MARKS/un-MARKS the file at the current cursor location.
VersaFAM v1.14 - 14 -
ALT/F1
thru
ALT/F10- Invokes external programs, as defined by ExtFunc verbs in
VFAM.DAT.
CTRL/A- Toggles the default PACKER from among a list of 7 selections.
PACKER returns to default when returning to the 1st-level menu.
CTRL/C- Capitalizes file descriptions at the cursor location.
CTRL/L- Lowercases file descriptions at the cursor location.
CTRL/O- Toggles OEC encode/decode ON or OFF.
CTRL/U- Uppercases file descriptions at the cursor location.
CTRL/F1
thru
CTRL/F10- Inserts a text template (specified by the Template verbs in
VFAM.DAT) at the current cursor position.
VersaFAM v1.14 - 15 -
-------------------------------------------------------------------
3RD-LEVEL MENU COMMANDS
-------------------------------------------------------------------
The 3rd-level menu displays contents of archived files for viewing
or further processing. The 3rd-level menu is accessed by selecting
the VIEW option at the 2nd menu level.
The following commands are available in the 3rd-level menu:
OS- Shells to DOS. Type 'EXIT' and then press <ENTER> to
return to VersaFAM.
TEXT- Allows viewing/editing of text files within an archived
file. If used in conjunction with the 'RepackEditFile'
verb in VFAM.DAT, the archive file may be updated with
the revised contents of the text file. The editor
specified must exist within the DOS path.
UNPACK- Swaps VersaFAM out of memory and activates an external
decompression utility. The identity of the utility is
dependent upon the archive type. When UNPACK is chosen
from the 3rd-level menu, it allows de-archiving of
individual files to the directory specified by the
'UnarcDir' verb in the VFAM.DAT configuration file.
The utilities ARCE, PAK, ZIP, LHA or LHARC must be available
in the DOS path for this function to work properly.
QUIT- Choose this menu option to quit the VersaFAM program.
ESC key- Used to back up to a previous menu, or quit VersaFAM.
VersaFAM v1.14 - 16 -
-------------------------------------------------------------------
THE OEC TEXT EDITOR
-------------------------------------------------------------------
VersaFAM incorporates an OEC-capable text editor for editing of text and
file descriptions within a list file. If a line containing a valid
filename is chosen, only the file description can be modified. If a
line containing a valid filename lacks a file description, a hyphen (-)
is placed in the first column of the file description as a "placeholder".
If a NON-FILE line is chosen, the entire line can be edited. The editor
is entered by selecting the WRITE option at the 2nd-level menu.
The following keystroke commands are available within the text editor:
ALT/I- Toggles between insert and overstrike cursor mode.
ALT/E- Deletes to the end of a line.
ALT/O- Inserts an OEC color code into a line. The resulting code
value depends on the text and background color settings
displayed in the lower left-hand corner of the screen during
text edit mode.
ALT/B- After an OEC code has been selected and placed using ALT-O,
an additional code to create a "blinking" effect may be
added by pressing ALT-B. All characters after this code
will blink, until another OEC code is encountered.
CTRL/<-> Moves cursor to beginning or end of a line. CTRL -> will
move the cursor to the last allowable character space on the
current line (127th column for file and non-file entries).
CTRL <- will move the cursor to the beginning of the line.
CTRL/X- Toggles <X-KEYS> mode when in REMOTE mode. X-Keys allows
selection of either cursor movement or number keys when
operating remotely.
TAB and
SHIFT/TAB- Tabs cursor forward and backward, respectively, on a line.
ALT/F1
thru
ALT/F10- Allows selection of graphics character sets.
F1
thru
F10- Allows output of graphics characters.
VersaFAM v1.14 - 17 -
CHANGING TEXT/BACKGROUND COLOR CODES
------------------------------------
Background color and low/high-intensity text color can be changed by
pressing the following keys when in the text editor:
COLOR (lo/hi) BACKGROUND(lo) TEXT(lo) TEXT(hi)
-----------------------------------------------------------
black/dk gray ALT-1 SHIFT-F1 CTRL-F1
blue/lt blue ALT-2 SHIFT-F2 CTRL-F2
green/lt green ALT-3 SHIFT-F3 CTRL-F3
cyan/lt cyan ALT-4 SHIFT-F4 CTRL-F4
red/lt red ALT-5 SHIFT-F5 CTRL-F5
magenta/lt magenta ALT-6 SHIFT-F6 CTRL-F6
brown/yellow ALT-7 SHIFT-F7 CTRL-F7
lt gray/white ALT-8 SHIFT-F8 CTRL-F8
HOW VERSAFAM INTERPRETS OEC CODES
---------------------------------
Opus and other BBS software disallows the use of most ASCII characters
on the first column of a non-file line. For example, if the letter 'A'
is typed in the first column of a file line, Opus will interpret this as
a filename, looking for a file named 'A'. Of course, this file will show
up as MISSING when listed in Opus.
VersaFAM v1.14 - 18 -
APPROVED CHARACTERS
-------------------
To get around this restriction when creating non-file text lines, you
must use an "Opus-approved" character in the first text column.
Characters that Opus accepts in this position are listed below:
Character ASCII value
CTRL-A 1
CTRL-B 2
CTRL-C 3
CTRL-D 4
CTRL-E 5
CTRL-F 6
CTRL-G 7
CTRL-H 8
CTRL-I 9
CTRL-J 10
CTRL-K 11
CTRL-L 12
CTRL-M 13
CTRL-N 15
CTRL-O 16
CTRL-V 22
CTRL-Y 25
space 32
+ 43
, 44
- 45
: 58
< 60
= 61
> 62
[ 91
\ 92
] 93
^ 94
| 124
~ 126
When a character is entered in the first column of a non-file text
line in text edit mode, VersaFAM will check to see if the character is
"approved". If it is, it will be placed in the first text column.
If it is not an approved character, the text line will be padded at
the beginning by one character upon exiting the text editor. The
value of the pad character is ASCII 32 (space) by default, but can be
defined as any other "approved" character by listing the desired
character after the TEXTFLAG verb in the VFAM.DAT configuration file.
VersaFAM v1.14 - 19 -
INTERPRETED VS. UNINTERPRETED OEC DISPLAYS
------------------------------------------
VersaFAM implements a subset of the OEC (Opus Embedded Command) codes
used by Opus and other BBS software to control cursor movement, color
display and various other actions. When the 2nd-level menu cursor is
moved over a text line, the actual, "uninterpreted" text line,
complete with OEC codes, will be displayed. All other visible text
lines will display as "interpreted", showing the effects of any OEC
codes such as different colors, blinking, etc.
VERSAFAM OEC LIMITATIONS
------------------------
*ONLY* OEC commands having to do with the display of colors and
setting of the blink bit are recognized by VersaFAM. All other OEC
codes will be displayed "uninterpreted". Also unsupported are the
character compression commands (ASCII 25 codes) used in standard OEC.
A utility called OEC2VFAM has been included in this package to convert
standard OEC files to VersaFAM format by "expanding" any character
compression codes encountered, and writing the results to a new file.
Because the VersaFAM text editor is line-oriented, certain special
considerations must be given for OEC-coded text lines to display
properly. OEC codes must be present on *each line* of a multiple-line
OEC display.
VersaFAM v1.14 - 20 -
-------------------------------------------------------------------
USING TEXT TEMPLATES
-------------------------------------------------------------------
VersaFAM incorporates a powerful text editing feature known as
"text templating". Text templates are ASCII text files that can be
selectively inserted within list files, in order to relieve the tedium
often associated with editing such files. "Boiler-plate" files for
descriptive headers, text boxes and other intricate designs can be
inserted with a keystroke, without having to laboriously re-create them
from scratch every time they are needed.
Template files are inserted within a list file by pressing keys in the
range of CTRL-F1 through CTRL-F10, depending on which template is desired.
Template files may be modified while in VersaFAM by PROBEing the template
filename into the main list file, positioning the cursor on the template
file name, then pressing ALT-L. This displays the template file as an
"alternate" list file at the 2nd menu level. The template file may now
be edited like a normal list file by invoking the WRITE command. When the
2nd-level menu is exited, the regular list file name is reinstated.
It is recommended that template files be assigned their own special
subdirectory, and that this subdirectory be included in VersaFAM as an
ACTIVE directory, to facilitate convenient editing of template files.
VersaFAM v1.14 - 21 -
-------------------------------------------------------------------
RUNNING VERSAFAM REMOTELY
-------------------------------------------------------------------
VersaFAM can be set up for remote operation by specifying "VFAM /R"
in the batch file to be called. The presence of the /R parameter
signals VersaFAM to make all necessary adjustments for remote operation.
The only thing the remote user has to remember to do is engage his/her
NUM LOCK at the remote terminal.
Menu selections in remote mode work the same as in local mode, with
the exception of extended keycodes. Extended keycodes are ALT, CTRL,
SHIFT and function key combinations whose keycodes are not supported
by most communications or terminal programs. VersaFAM gets around this
obstacle through creation of a "shorthand" mnemonic code used to invoke
extended keycodes. Examples of this code are illustrated below:
Extended Keycode VersaFAM "shorthand" code
---------------- -------------------------
ALT/F1 A + F + 1 (3 keystrokes)
ALT/1 A + 1
F6 F + 6
ALT/C A + C
ALT/F10 A + F + 0
CTRL/F1 C + F + 1
SHIFT/F1 S + F + 1
"Shorthand" code functionality is automatically available on 1st and 2nd
level menus when running remotely. A special "kludge" is needed for
bringing this functionality to the Text Editor, however. To distinguish
the letter "A" from an ALT shorthand code for example, the <X-KEYS> mode
has been created. <X-KEYS> can only be invoked in remote mode, when the
Text Editor is active. When the CTRL-X keystroke combination (not an
extended keycode) is pressed while in the Text Editor, <X-KEYS>
will appear next to the <INDEX> legend. Press CTRL-X again to toggle
X-KEYS mode off.
When not in X-KEYS mode, the following is true:
A. Pressing letter keys will output letters to the screen.
B. Pressing number keys will result in cursor movement.
C. Pressing cursor keys will result in cursor movement.
D. Entering "shorthand" codes will have no effect.
When in X-KEYS mode:
A. Pressing letter keys (except letters A, C, F or S) will
output uppercase letters to the screen.
B. Pressing number keys will output numbers to the screen.
C. Pressing cursor keys will output numbers to the screen.
D. Entering "shorthand" codes will produce the desired effect.
VersaFAM v1.14 - 22 -
-------------------------------------------------------------------
VERSAFAM UTILITIES
-------------------------------------------------------------------
The VersaFAM distribution package includes several utility programs
designed specifically for use with VersaFAM.
FILEX FILE UPDATE UTILITY
-------------------------
FILEX.EXE provides a convenient method for adding new files and
file descriptions to file areas when invoked as an external program.
FILEX can also be run from the DOS prompt, or from within a batch file.
Read FILEX.DOC for more information.
CBFSORT FILE SORT UTILITY
-------------------------
CBFSORT.EXE is an exceptionally fast sort routine based on original code
by Charles B. Falconer, a local professional programmer. The CBFSORT
program sorts individual groupings of valid file lines within a list file,
without disturbing surrounding text or descriptive data. CBFSORT is
available as a "hard-coded" external program call, but can also be run
from DOS or from within a batch file.
OEC2VFAM CONVERSION UTILITY
---------------------------
In recognition of the fact that most sysops will already have established
file areas before using VersaFAM, the OEC2VFAM utility has been included to
convert "standard" OEC-format files to VersaFAM format. This conversion
involves expansion of ASCII 25 compression codes used in standard OEC,
replacing such codes with the actual characters they represent. OEC2VFAM
will scan a specified input file, then write the converted results to an
output file, eliminating the need to manually re-format list files.
VFADD PATH IMPORT UTILITY
-------------------------
The VFADD utility allows sysops of Opus<tm> BBSes to append VFAM.DAT
with download path information taken from any existing SYSTEM??.BBS
or SYSTEM??.DAT files located in the directory from which VFADD is
called. Before appending, path information can be sorted either
according to SYSTEM?? file hierarchy (the default), or alphanumerically
according to the path itself.
VersaFAM v1.14 - 23 -
-------------------------------------------------------------------
CREDITS AND COPYRIGHTS
-------------------------------------------------------------------
ARCA, ARCE Copyright (C) System Enhancement Associates
ARJ Copyright (C) Robert K. Jung
PAK Copyright (C) NoGate Consulting
LHARC, LHA Copyright (C) Haruyasu Yoshizaki
LIST Copyright (C) Vernon D. Buerg
PKZIP, PKUNZIP Copyright (C) Phil Katz/PKWare
DOORWAY Copyright (C) Marshall Dudley
-------------------------------------------------------------------
THE VERSAFAM BETA TEST TEAM
-------------------------------------------------------------------
My heartfelt thanks to the following people for debugging my
(sometimes imperfect) dream and making VersaFAM a reality:
Don Dawson, Bowen Goletz, Karl Hoedl, Moe Lanza, Rick Moore,
Dale Pausinga, Furlan Primus, Chris Regan, Jose Avelar, Rick Ashworth
and any other testers whose names I may have forgotten in the heat of
the moment....
-------------------------------------------------------------------
HOW TO CONTACT THE AUTHOR
-------------------------------------------------------------------
Please send all VersaFAM comments, criticisms and bug reports to:
Bill Auclair
Xanadu BBS, Naugatuck CT USA
FidoNet 1:141/545.0
-------------------------------------------------------------------
REGISTRATION
-------------------------------------------------------------------
Registering the VersaFAM package ($15.00) will entitle you to:
a) A customized VersaFAM executable file.
b) Free program updates via FidoNet or U.S. Snail.
c) My heartfelt thanks.
More details on registration are available in the REGISTER.DOC file.
NOTE: This unregistered version of VersaFAM is NOT CRIPPLED IN ANY WAY.
-------------------------------------------------------------------
MORE ABOUT TURBOPOWER SOFTWARE
-------------------------------------------------------------------
If you'd like to know more about TurboPower Software and their
many fine public domain and shareware programs, write to Kim
Kokkonen at the following address:
Kim Kokkonen, President
TurboPower Software
P.O. Box 66747
Scotts Valley, CA 95066